docs: Add guide for running CI tests locally with tox-lsr#796
docs: Add guide for running CI tests locally with tox-lsr#796richm merged 1 commit intolinux-system-roles:mainfrom
Conversation
Reviewer's GuideIntroduces a new “Running CI Tests Locally” section in contributing.md that guides developers through using tox-lsr and QEMU to execute CI tests on their local machines. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @liangwen12year - I've reviewed your changes - here's some feedback:
- Consider pinning the tox-lsr installation to a stable release tag instead of
@mainto avoid breakage when upstream changes occur. - It may be helpful to note that qemu-based tests require virtualization tools (e.g.
qemu-system-x86_64) and appropriate permissions or root access to launch VMs. - The yum/dnf and pip install commands likely need
sudo; consider explicitly showing when to prefix withsudoto prevent permission issues.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider pinning the tox-lsr installation to a stable release tag instead of `@main` to avoid breakage when upstream changes occur.
- It may be helpful to note that qemu-based tests require virtualization tools (e.g. `qemu-system-x86_64`) and appropriate permissions or root access to launch VMs.
- The yum/dnf and pip install commands likely need `sudo`; consider explicitly showing when to prefix with `sudo` to prevent permission issues.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #796 +/- ##
==========================================
+ Coverage 43.11% 43.25% +0.13%
==========================================
Files 12 12
Lines 3124 3121 -3
==========================================
+ Hits 1347 1350 +3
+ Misses 1777 1771 -6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| 5. Assuming you are in a git clone of a role repo which has a tox.ini file - you can use e.g. | ||
|
|
||
| ```bash | ||
| tox -e qemu-ansible-core-2.14 -- --image-name rhel-9-2 tests/tests_default.yml |
There was a problem hiding this comment.
Upstream users wouldn't be able to use rhel, change to centos-9
There was a problem hiding this comment.
I changed it to centos-9, thanks!
|
This should also go into https://github.com/linux-system-roles/.github/blob/main/playbooks/templates/contributing.md |
6ea76b1 to
9df2ced
Compare
Signed-off-by: Wen Liang <liangwen12year@gmail.com>
9df2ced to
ada9434
Compare
I created a PR, thanks, linux-system-roles/.github#121. |
Enhancement:
Reason:
Result:
Issue Tracker Tickets (Jira or BZ if any):
Summary by Sourcery
Documentation: